home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / gth035.zip / PAGECODE.HLP < prev    next >
Text File  |  1990-08-11  |  5KB  |  157 lines
  1.  
  2. ╔═════════╦════════════════════════════════════════════════════════════
  3. ║ GT-HELP ║ BBS files - page breaks and miscellaneous codes
  4. ╚═════════╩════════════════════════════════════════════════════════════
  5.  
  6.  
  7. ┌─────────────┐
  8. │ Page Breaks │
  9. └─────────────┘
  10.  
  11.     GT will by default insert a MORE? prompt when the screen becomes full.
  12.     But it is usually convenient to predefine sensible positions for the
  13.     breaks :
  14.  
  15.     a)  put a  (CTRL-R) at the beginning of the file to disable generation
  16.         of default MORE prompts for the remainder of the file.
  17.  
  18.     b)  put a  (CTRL-E) at the beginning of a line on its own to instruct
  19.         GT to generate a MORE prompt at that point.
  20.  
  21.     If the MORE break is between paragraphs, it looks best to sandwich
  22.     the  line between blanks, ie ...
  23.     
  24.       |choose something that *you* can remember but others would be unlikely
  25.       |to guess.
  26.       |
  27.       |
  28.       |
  29.       |OK, the two password questions are coming up, but first a quick reminder:
  30.       |etc
  31.       
  32.  
  33. ┌───────────────┐
  34. │ Substitutions │
  35. └───────────────┘
  36.  
  37.     A substitution line must begin with  (CTRL-U) in column 1.  Any
  38.     "ordinary" text on that line must then be enclosed in quotes.
  39.  
  40.     For example :
  41.  
  42.         "Hello "F", welcome to Grapevine UK."
  43.  
  44.      is CTRL-U or ALT-21 and must be in column 1.
  45.  
  46.     The quotes go around the *text*, not around the substitution 
  47.     characters (though it often looks the other way round if you read it 
  48.     quickly).
  49.  
  50.  
  51. Substitutions available
  52. -----------------------
  53.  
  54.           D ... The current calendar date.
  55.           T ... The current time of day.
  56.  
  57.           F ... The caller's first name.
  58.           N ... The caller's full name.
  59.           H ... The caller's home - city and state.
  60.           C ... The caller's number (i.e. the 100th caller).
  61.  
  62.           A ... The DTE baud rate.
  63.           B ... The DCE baud rate.
  64.  
  65.           M ... The current message base description.
  66.           S ... The current file section description.
  67.  
  68.           L ... Time left for current session in minutes.
  69.           R ... The caller's upload amount in kilobytes.
  70.           RF .. The caller's upload amount in number of files.
  71.           S ... The current file section description.
  72.           X ... The caller's download amount in kilobytes.
  73.           XF .. The caller's download amount in number of files.
  74.  
  75.     If you wish to control the length of a substituted field (eg if you
  76.     want to align multiple columns) you can place a width instruction in 
  77.     front of the substitution code.  
  78.     
  79.     For example, W20F will display the caller's first name in a 20 
  80.     character field.  So you could enclose it in an ASCII box with :
  81.     
  82.             ┌──────────────────────┐
  83.             │ Hello                │
  84.             "│ "W20F" │"
  85.             └──────────────────────┘
  86.  
  87.     Although the alignment "looks" wrong, when the field expands to 20 
  88.     characters the sides of the box will be correctly aligned.
  89.  
  90. Hints
  91. -----
  92.  
  93.     Substitutions other than D and T are unlikely to be useful in 
  94.     GTWELCOM.BBS since the caller has not yet logged on and most of the 
  95.     answers will be undefined.
  96.     
  97.     Use substitutions only when it serves a useful purpose, otherwise 
  98.     callers will think you work for Readers Digest.
  99.  
  100.  
  101. ┌─────────┐ 
  102. │ Nesting │
  103. └─────────┘
  104.   
  105.     You can "call in" another file :
  106.  
  107.         common.inc
  108.                 
  109.     will cause common.inc to be displayed at this point.   is CTRL-F and 
  110.     must be in column 1.
  111.         
  112.     Nesting is useful where you want the same paragraph to be common to 2 or 
  113.     more files, particularly if you update it regularly since you only have
  114.     to update it in one place.  It is also a very useful way of "pasting in"
  115.     the output of a report which is periodically generated by a program.
  116.     
  117.     You are not recommended to nest to files which perform further nesting. 
  118.     But having returned from the nested file, the original file may call 
  119.     further files in the same manner.
  120.  
  121.  
  122. ┌──────────────┐
  123. │ ^K disabling │
  124. └──────────────┘
  125.  
  126.     Normally callers can terminate display of a file by pressing CTRL-K.  
  127.     If you particularly want them to read to the end of a file, you can 
  128.     disable the ^K checking by including a line beginning with  (CTRL-T).
  129.     
  130.     Disabling ^K is very unpopular with callers - you should only do it 
  131.     for matters of great importance, if at all.
  132.  
  133.  
  134. ┌─────────────────────────┐
  135. │ About Displayable Files │
  136. └─────────────────────────┘
  137.  
  138.     GT will usually begin displaying files on the immediate next line.
  139.     This can make things difficult to read, and it looks particularly
  140.     odd if the file contains several paragraphs with blank lines between
  141.     them.  
  142.     
  143.     So, it is useful to begin displayable files with either:
  144.  
  145.     a)  One or more blank lines
  146.     
  147.     b)  A visible division such as --------- or ==========
  148.     
  149.     
  150.     The IBM box drawing characters can also be used, so far as GT is 
  151.     concerned.  But they do not make sense to callers that don't have
  152.     PC's.  So if you have lots of non-PC callers it might be wise to 
  153.     avoid using them in the .BBS versions of your files.
  154.  
  155.  
  156.  
  157.